www.gusucode.com > Piwik 网站流量统计系统 v2.9.1PHP源码程序 > Piwik 网站流量统计系统 v2.9.1/piwik/piwik/vendor/mnapoli/phpdocreader/src/PhpDocReader/PhpDocReader.php
<?php namespace PhpDocReader; use Doctrine\Common\Annotations\PhpParser; use ReflectionParameter; use ReflectionProperty; /** * PhpDoc reader * * @author Matthieu Napoli <matthieu@mnapoli.fr> */ class PhpDocReader { /** * @var PhpParser */ private $phpParser; private $ignoredTypes = array( 'bool', 'boolean', 'string', 'int', 'integer', 'float', 'double', 'array', 'object', 'callable', 'resource', ); /** * Enable or disable throwing errors when PhpDoc Errors occur (when parsing annotations) * * @var bool */ private $ignorePhpDocErrors; /** * * @param bool $ignorePhpDocErrors */ public function __construct($ignorePhpDocErrors = false) { $this->phpParser = new PhpParser(); $this->ignorePhpDocErrors = $ignorePhpDocErrors; } /** * Parse the docblock of the property to get the class of the var annotation. * * @param ReflectionProperty $property * * @throws AnnotationException * @return string|null Type of the property (content of var annotation) * * @deprecated Use getPropertyClass instead. */ public function getPropertyType(ReflectionProperty $property) { return $this->getPropertyClass($property); } /** * Parse the docblock of the property to get the class of the var annotation. * * @param ReflectionProperty $property * * @throws AnnotationException * @return string|null Type of the property (content of var annotation) */ public function getPropertyClass(ReflectionProperty $property) { // Get the content of the @var annotation if (preg_match('/@var\s+([^\s]+)/', $property->getDocComment(), $matches)) { list(, $type) = $matches; } else { return null; } // Ignore primitive types if (in_array($type, $this->ignoredTypes)) { return null; } // Ignore types containing special characters ([], <> ...) if (! preg_match('/^[a-zA-Z0-9\\\\_]+$/', $type)) { return null; } $class = $property->getDeclaringClass(); // If the class name is not fully qualified (i.e. doesn't start with a \) if ($type[0] !== '\\') { $alias = (false === $pos = strpos($type, '\\')) ? $type : substr($type, 0, $pos); $loweredAlias = strtolower($alias); // Retrieve "use" statements $uses = $this->phpParser->parseClass($property->getDeclaringClass()); $found = false; if (isset($uses[$loweredAlias])) { // Imported classes if (false !== $pos) { $type = $uses[$loweredAlias] . substr($type, $pos); } else { $type = $uses[$loweredAlias]; } $found = true; } elseif ($this->classExists($class->getNamespaceName() . '\\' . $type)) { $type = $class->getNamespaceName() . '\\' . $type; $found = true; } elseif (isset($uses['__NAMESPACE__']) && $this->classExists($uses['__NAMESPACE__'] . '\\' . $type)) { // Class namespace $type = $uses['__NAMESPACE__'] . '\\' . $type; $found = true; } elseif ($this->classExists($type)) { // No namespace $found = true; } if (!$found && !$this->ignorePhpDocErrors) { throw new AnnotationException(sprintf( 'The @var annotation on %s::%s contains a non existent class "%s". ' . 'Did you maybe forget to add a "use" statement for this annotation?', $class->name, $property->getName(), $type )); } } if (!$this->classExists($type) && !$this->ignorePhpDocErrors) { throw new AnnotationException(sprintf( 'The @var annotation on %s::%s contains a non existent class "%s"', $class->name, $property->getName(), $type )); } // Remove the leading \ (FQN shouldn't contain it) $type = ltrim($type, '\\'); return $type; } /** * Parse the docblock of the property to get the class of the param annotation. * * @param ReflectionParameter $parameter * * @throws AnnotationException * @return string|null Type of the property (content of var annotation) * * @deprecated Use getParameterClass instead. */ public function getParameterType(ReflectionParameter $parameter) { return $this->getParameterClass($parameter); } /** * Parse the docblock of the property to get the class of the param annotation. * * @param ReflectionParameter $parameter * * @throws AnnotationException * @return string|null Type of the property (content of var annotation) */ public function getParameterClass(ReflectionParameter $parameter) { // Use reflection $parameterClass = $parameter->getClass(); if ($parameterClass !== null) { return $parameterClass->name; } $parameterName = $parameter->name; // Get the content of the @param annotation $method = $parameter->getDeclaringFunction(); if (preg_match('/@param\s+([^\s]+)\s+\$' . $parameterName . '/', $method->getDocComment(), $matches)) { list(, $type) = $matches; } else { return null; } // Ignore primitive types if (in_array($type, $this->ignoredTypes)) { return null; } // Ignore types containing special characters ([], <> ...) if (! preg_match('/^[a-zA-Z0-9\\\\_]+$/', $type)) { return null; } $class = $parameter->getDeclaringClass(); // If the class name is not fully qualified (i.e. doesn't start with a \) if ($type[0] !== '\\') { $alias = (false === $pos = strpos($type, '\\')) ? $type : substr($type, 0, $pos); $loweredAlias = strtolower($alias); // Retrieve "use" statements $uses = $this->phpParser->parseClass($class); $found = false; if (isset($uses[$loweredAlias])) { // Imported classes if (false !== $pos) { $type = $uses[$loweredAlias] . substr($type, $pos); } else { $type = $uses[$loweredAlias]; } $found = true; } elseif ($this->classExists($class->getNamespaceName() . '\\' . $type)) { $type = $class->getNamespaceName() . '\\' . $type; $found = true; } elseif (isset($uses['__NAMESPACE__']) && $this->classExists($uses['__NAMESPACE__'] . '\\' . $type)) { // Class namespace $type = $uses['__NAMESPACE__'] . '\\' . $type; $found = true; } elseif ($this->classExists($type)) { // No namespace $found = true; } if (!$found && !$this->ignorePhpDocErrors) { throw new AnnotationException(sprintf( 'The @param annotation for parameter "%s" of %s::%s contains a non existent class "%s". ' . 'Did you maybe forget to add a "use" statement for this annotation?', $parameterName, $class->name, $method->name, $type )); } } if (!$this->classExists($type) && !$this->ignorePhpDocErrors) { throw new AnnotationException(sprintf( 'The @param annotation for parameter "%s" of %s::%s contains a non existent class "%s"', $parameterName, $class->name, $method->name, $type )); } // Remove the leading \ (FQN shouldn't contain it) $type = ltrim($type, '\\'); return $type; } /** * @param string $class * @return bool */ private function classExists($class) { return class_exists($class) || interface_exists($class); } }